home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / STBAR20.ZIP / CUSTOM.DOC < prev    next >
Encoding:
Text File  |  1996-04-12  |  6.1 KB  |  163 lines
  1.                          Customizing StarBar V2.0
  2. -----------------------------------------------------------------------------
  3.  
  4. Colours:
  5. --------
  6.  
  7.   There are two ways to change colours used within StarBar.
  8.     1) Use raw colour codes within StarBar.MH
  9.     2) Use colour defines in the StarBar.LH file.
  10.  
  11. Method 1:
  12.          This is pretty much explained in the StarBar.MH file, but I will
  13.          go over it here also.
  14.          In StarBar.MH, we have #define Statements which look like this:
  15.  
  16.                 #define ST_COL_DESC         "\x16\x01\x03"
  17.                                              ^^^^^^^^^^^^
  18.                                              This is the raw HEX colour
  19.                                              code for CYAN.
  20.  
  21.          So, this statement tells StarBar it should print the file
  22.          description in CYAN.
  23.          Suppose we wanted to print it in BROWN? First, we need to know
  24.          the raw HEX code for BROWN. Have a look in COLOURS.TXT. On line
  25.          7 of that file we see that the colour code for BROWN is
  26.          \x16\x01\x06.
  27.          You will notice that the \x16\x01 part of the colour code appears
  28.          in all the colour codes. So, all we have to do is replace the
  29.          \x03 above with \x06
  30.  
  31.                 #define ST_COL_DESC         "\x16\x01\x06"
  32.  
  33.          Now our descriptions will be printed in BROWN.
  34.  
  35.          You can change any of the #defines in StarBar.MH which contain
  36.          colour codes to anything found in COLOURS.TXT.
  37.  
  38.          When changing any #defines in StarBar.MH, take notice of any spaces
  39.          (within the quotes), as they are there for a reason.
  40.  
  41. Method 2:
  42.          Colours for most of the strings used by StarBar are in the
  43.          StarBar.LH language file. In this file, you can use the colour
  44.          word to define the colour.
  45.  
  46.          EG:
  47. st_no_access=      LRED "Sorry, you don't have access to this function!\n\n";
  48.                    ^^^^
  49.                    Prints the access string in LightRed.
  50.  
  51.          One side-note. Make sure you leave any control chars encountered as
  52.          they are. (the "\n\n" above is a good example. More on this below)
  53.  
  54.          Also, I recommend sticking to the first 16 colour words listed in
  55.          COLOURS.TXT.
  56.  
  57.  
  58. Language Files:
  59. ---------------
  60.  
  61.   StarBar is capable of using multiple language files. Once you have your
  62. primary language file using StarBar.LH, you can copy this file to another
  63. name and include it in other language files.
  64.   However, if you don't have translated StarBar language files, I recommend
  65. including StarBar.LH in all your "user heaps" in all the language files
  66. you run.
  67.   If you have translated StarBar language files, include the file in the
  68. appropriate language files.
  69.  
  70.   For instance, say you have a French language file for StarBar called
  71. STARFR.LH. Put it in your ..\m dir and include this filename in your
  72. french language "user heap". (Same method as described in STARBAR.DOC)
  73.   MAID the French language file, and try it out. Run StarBar under French
  74. and have a look.
  75.  
  76.  
  77.   Translating:
  78.   ------------
  79.  
  80.   Translating the StarBar.LH file shouldn't prove to be too difficult, but
  81. there are a few things you should keep in mind:
  82.  
  83.   - Some strings should be kept close or at the same length. Especially
  84.     the st_com_* strings as they are used in the command line which appears
  85.     at the bottom of the StarBar screen. If they are too long, they will
  86.     bleed onto the next line and will mess up the lightbar positioning
  87.     for the remote user.
  88.   - Take care to preserve the control characters (EG: "\n\n") These are
  89.     line feed characters and may have undesired effects on other strings
  90.     if omitted.
  91.   - Make sure you don't touch the   =starbar   statement which appears
  92.     after the version #define.
  93.   - Enclose all text in quotes (not the colour words)
  94.   - End each string with a   ;
  95.  
  96.  
  97. Help Files:
  98. -----------
  99.  
  100.   StarBar will make use of additional help files if they are available. The
  101. default help file is SBHELP0.BBS. The "0" indicates this is a help file for
  102. language #1. Language #2 would use SBHELP1.BBS. If a help file doesn't
  103. exist for a particular language, SBHELP0.BBS will be displayed by default.
  104.  
  105.   If your French language file is #4 in your change language menu, then
  106. SBHELP3.BBS will be displayed.
  107.  
  108.  
  109.   Translating:
  110.   ------------
  111.  
  112.   Simply copy SBHELP0.MEC to the appropriate language number and edit all
  113. the text. For French being Language #4, copy SBHELP0.MEC to SBHELP3.MEC,
  114. edit the text then MECCA SBHELP3.MEC.
  115.  
  116.  
  117.   Keep in mind, if you change any hotkeys (explained below) you will have
  118. to change the help files to reflect the change. EG: if you change X)Exit to
  119. Q)uit, you will have to make the change in the help file, or your users
  120. may become confused. (doesn't take much I know...<G>)
  121.  
  122.  
  123. HotKeys:
  124. --------
  125.  
  126.   You can change some of the hotkey definitions in the STARBAR.MH file.
  127. Just change the KEY_* as described in STARBAR.MH. Most hotkeys cannot
  128. be changed (there shouldn't be a reason to change the KEY_DOWN #define,
  129. for instance).
  130.   EG: To change [X]Exit to [Q]Quit we would do this:
  131.  
  132.   - In STARBAR.MH, change:
  133.  
  134.          #define KEY_EXIT     "Xx"
  135.                  to
  136.          #define KEY_EXIT     "Qq"  <-- You need both upper and lowercase!
  137.  
  138.   - In STARBAR.LH, change
  139.  
  140.          st_com_exit=    GREEN "Exit ";
  141.                  to
  142.          st_com_exit=    GREEN "Quit "; <-- Take note of the space needed!
  143.  
  144.   - In SBHELP#.MEC, change the lines which refer to "X" being needed to o
  145.     exit the program to "Q".
  146.  
  147.   - Now, you will have to MAID <language>.mad , MEX STARBAR , and MECCA
  148.     SBHELP#.MEC to process the changes.
  149.  
  150. StarBar will now use "Q" to quit the program and the change will be noted
  151. on the command footer.
  152.  
  153.  
  154.  
  155. -----------------------------------------------------------------------------
  156.  
  157.   Basically, just play with StarBar until you get it working and looking
  158. the way you want.
  159.   If you have any problems, feel free to send me mail, and I will get a
  160. response to you with a solution.
  161.  
  162.   See REGISTER.DOC for addresses...
  163.